CiscoXaaSBilling
Request Message by Subscription ID
You could request for usage data through two methods, by invoice number(s) or by date range:
- By Subscription ID(s)
-Partners can make a request by a single Subscription ID or a set of Subscription ID. Request will have a maximum of 20 Subscription ID
-This is the preferred method to request for usage data
-This method will take precedence over date range (in the case of both invoice number(s) and date range are entered)
-When a set of invoice numbers are sent, the response message will only contain information for the valid invoice number
-When BID does not match with invoice number, there will not be a response for this requestBy date range
-Partners can request for usage data up to six months from present date
-Begin and end dates must be in correct format
Upon a successful request, the system will response with hyperlinks to download the SaaS Usage file (.zip file). Each Invoice Number will have its own unique hyperlink to a download its SaaS Usage file. Each SaaS Usage file contains one Invoice Header file and one Consolidated Usage file (.csv file). Please refer to Usage Download File Overview for more information.
Note: The download links will be active for 24 Hours. Please download your Usage files during that time. Once access expires, you must make another API request to receive a new URL.
##Cardinality Ref
Please use the following annotation for the Usage API Structure table:
| Cardinality Description1 Required. Only one instance1...NRequired. One or more instances | Cardinality Description0Optional. Only one instance0...NOptional. One or more instances |
Usage API Structure
The following table displays all elements in a request message.
| No. | Element | Cardinality | Specification |
|---|---|---|---|
| 1 | uuid | 1 | Message unique identifier (provided by Partner) Type: String Example: "uuid":"7981654" |
| 2 | createdBy | 1 | User identification (User CCO ID) Type: String (chars 50) Example: "createdBy":"TomPaine" |
| 3 | createdDateTime | 1 | Time and date Format: YYYY-MM-DDTHH:MM:SS.000Z Type: String Example: "createdDateTime":"2017-07-31T11:43:38.000Z" |
| 4 | billingAddressId | 1 | BID identification Type: String Example: "billingAddressId":"345675" |
| 5 | subscriptionList | 1 | List of Subscription ID Type: Array (Range: 0-50) Example: "subscriptionList":[ ... , ...] |
| 6 | beginDate | 1 | Start date of the date range Format: YYYY-MM-DDTHH:MM:SS.000Z Type: String Example: "beginDate": "2017-04-31T11:43:38.000Z" |
| 7 | endDate | 1 | End date of the date range Format: YYYY-MM-DDTHH:MM:SS.000Z Type: String Example: "endDate": "2017-07-31T11:43:38.000Z" |
| 8 | pageNumber | 0...N | Requesting page number We suggest to set the value to 1 on first request Please use the value of totalPage in the response message to determine the next value in this field Type: Number (Range: 1 - 999999999999999) Example: "pageNumber": 1 |